Skip to content

Conversation

@heckj
Copy link
Contributor

@heckj heckj commented Oct 21, 2025

Provide organization (aka curation) and abstracts for all of the public types in the library.

Motivation:

Updates to the documentation to fill in the missing abstracts for the provided types, updating the language to follow Apple developer content guidelines, and fixing smaller typos and grammar issues.

Modifications:

Curation files added to provide organization for public types, ordering the content to align with the narrative content provided earlier. Updating API comments, adding abstracts and parameters where missing, and moving some of the getting started content that was previously in the main index into a separate article.

Result:

starting point

   --- Experimental coverage output enabled. ---
                | Abstract        | Curated         | Code Listing
Types           | 69% (11/16)     | 38% (6/16)      | 25% (4/16)
Members         | 57% (54/94)     | 3.2% (3/94)     | 0.0% (0/94)
Globals         | 7.1% (1/14)     | 7.1% (1/14)     | 7.1% (1/14)

Updated:

                | Abstract        | Curated         | Code Listing
Types           | 94% (15/16)     | 94% (15/16)     | 38% (6/16)
Members         | 85% (80/94)     | 97% (91/94)     | 0.0% (0/94)
Globals         | 14% (2/14)      | 100% (14/14)    | 7.1% (1/14)

heckj added 8 commits October 24, 2025 17:44
- added organization for methods in all public types (curation).
- reworded abstracts to not use code voice or symbols.
- revised some abstracts to present a single sentence.
- reworded some parameters and article content to remove the use of passive voice
  or future tense.
@heckj heckj marked this pull request as ready for review October 25, 2025 00:55
@czechboy0 czechboy0 added the semver/none No version bump required. label Oct 27, 2025
Copy link
Contributor

@czechboy0 czechboy0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @heckj, a few comments

@heckj heckj requested a review from czechboy0 October 27, 2025 15:23
Copy link
Contributor

@czechboy0 czechboy0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more set of suggestions, but lgtm otherwise

Copy link
Member

@FranzBusch FranzBusch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this LGTM. I left one smaller NIT.

@heckj heckj merged commit 4121d24 into apple:main Nov 3, 2025
46 checks passed
@heckj heckj deleted the expand-docs branch November 3, 2025 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

semver/none No version bump required.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants